Conversation
Adopt a Kubernetes-style API reference layout in generated docs. - Keep Spec/Status tables focused on top-level fields. - Render referenced local types later on the same page under a dedicated section. - Link local types to same-page anchors and keep Kubernetes types linked to upstream API docs. - Regenerate all API reference pages using the updated template. --- _Generated with `mux` • Model: `openai:gpt-5.3-codex` • Thinking: `xhigh` • Cost: `$0.67`_ <!-- mux-attribution: model=openai:gpt-5.3-codex thinking=xhigh costs=0.67 -->
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9dab06c4c9
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Address docs-quality CI failures from markdownlint by tightening generated Markdown output. - Refined the API reference template row/type rendering to reduce malformed line merges. - Added post-generation blank-line normalization in `hack/update-reference-docs.sh`. - Regenerated API reference docs and verified markdownlint/cspell cleanliness. --- _Generated with `mux` • Model: `openai:gpt-5.3-codex` • Thinking: `xhigh` • Cost: `$0.67`_ <!-- mux-attribution: model=openai:gpt-5.3-codex thinking=xhigh costs=0.67 -->
|
@codex review |
Prevent markdown table breakage by normalizing generated blank lines in API reference docs. - Keep at most one consecutive blank line globally. - Remove blank lines that appear directly after markdown table separator rows. - Preserve deterministic docs output in `make docs-reference` for CI checks. --- _Generated with `mux` • Model: `openai:gpt-5.3-codex` • Thinking: `xhigh` • Cost: `$0.67`_ <!-- mux-attribution: model=openai:gpt-5.3-codex thinking=xhigh costs=0.67 -->
|
@codex review |
|
Codex Review: Didn't find any major issues. Already looking forward to the next diff. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
1 participant
Summary
This PR reworks generated API reference docs to use a Kubernetes-style, linkable layout that is easier to scan.
Background
Our previous output flattened nested fields into tree-style rows within the top-level Spec/Status tables. That made pages dense and hard to navigate, and repeated shared types across rows.
Implementation
hack/crd-ref-docs/templates/markdown/gv_list.tplto:## Referenced typessection with type-specific field tables.crd-ref-docslink rendering.docs/reference/api/*.md.Validation
make verify-vendormake testmake buildmake lintmake docs-referencemkdocs build --strictRisks
Low to medium. This change is template/output focused and does not affect runtime behavior, but link structure and table formatting could impact readability and downstream docs expectations.
Generated with
mux• Model:openai:gpt-5.3-codex• Thinking:xhigh• Cost:$0.67